Skip to content

docs: Mintlify site for openscience.sh/docs#86

Merged
Aayam Bansal (aayambansal) merged 1 commit into
mainfrom
docs/mintlify-site
Jul 5, 2026
Merged

docs: Mintlify site for openscience.sh/docs#86
Aayam Bansal (aayambansal) merged 1 commit into
mainfrom
docs/mintlify-site

Conversation

@aayambansal

Copy link
Copy Markdown
Member

New Mintlify documentation site in a top-level docs/ directory, ported from the Astro docs content in frontend/docs/src/content/docs/ and corrected against the current repo. The Astro site is untouched in this PR. Validated with npx mint validate (build validation passed) and npx mint broken-links (no broken links).

Fixes #37

Pages

  • index - what OpenScience is, plus a quickstart
  • installation - install script, package managers, launcher, Windows, binaries, upgrade/uninstall
  • config - openscience.json format, locations, precedence, all options, variables
  • models - model selection, defaults, variants, loading order
  • providers - credentials, Atlas, provider directory, local models, custom providers
  • permissions - allow/ask/deny, granular rules, external directories, defaults
  • rules - AGENTS.md, locations, precedence, custom instructions
  • themes - built-in themes, system theme, custom theme JSON
  • agents - primary agents, subagents, built-ins, JSON/markdown config, all options
  • tools - built-in tools and how permissions govern them
  • mcp-servers - local/remote servers, OAuth, per-agent management, examples
  • skills - SKILL.md locations, discovery, frontmatter, permissions
  • atlas - connect login, the two credential stores, wallet billing, spend modes
  • share - sharing modes, unsharing, privacy
  • cli - full command reference including connect/billing, global flags, env vars
  • troubleshooting - logs, storage, common errors
  • contributing - pointer to CONTRIBUTING.md, repo layout, dev workflow

Plus docs.json (mint theme, teal #0d9488 primary, dark default, GitHub/npm anchors), the wordmark logo, favicon, and a 3-line docs/README.md.

Content corrections applied while porting

  • Removed the Docker install tab: ghcr.io/synthetic-sciences/openscience does not exist (Docs quickstart documents a Docker image that doesn't exist #37). Marked Mise as community-maintained and untested.
  • Install one-liner is curl -fsSL https://openscience.sh/install | bash; npm is npm install -g @synsci/openscience; launcher is npx synsci.
  • Every $schema example now uses https://openscience.sh/config.json (was syntheticsciences.ai/config.json).
  • The built-binary dev path is ./backend/cli/dist/@synsci/openscience-<platform>/bin/openscience; repo layout documented as frontend/ backend/ tooling/ with main as the default branch.
  • Atlas page now describes the two credential stores accurately: openscience auth login keys stay local in auth.json and are never uploaded; openscience connect login stores a thk_ session key and pulls dashboard-connected credentials down; local keys win over synced ones; the spend toggle (billing.llm/billing.compute, managed vs byok) governs wallet gating, not which key is used.
  • Documented the connect (login/status/sync/devices/logout) and billing (show/topup) CLI commands, which were missing from the old CLI reference.
  • Dropped the desktop-app troubleshooting section (no desktop app ships from this repo) and the unverifiable Discord link.
  • GitHub links normalized to https://github.com/synthetic-sciences/openscience; docs cross-links resolve under https://openscience.sh/docs/.

To go live

  • Connect the repo in the Mintlify dashboard with docs/ as the content directory (branch main after merge)
  • Point the openscience.sh /docs rewrite at the Mintlify deployment
  • Verify https://openscience.sh/docs renders and cross-links resolve

@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openscience Ready Ready Preview, Comment Jul 5, 2026 11:54am

Request Review

@aayambansal Aayam Bansal (aayambansal) merged commit c3bbd74 into main Jul 5, 2026
11 checks passed
@aayambansal Aayam Bansal (aayambansal) deleted the docs/mintlify-site branch July 5, 2026 11:59
Aayam Bansal (aayambansal) added a commit that referenced this pull request Jul 5, 2026
* Revert "docs: Mintlify site for openscience.sh/docs (#86)"

This reverts commit c3bbd74.

* docs: OpenScience docs site for openscience.sh/docs

Replace the docs package with a small Vite + React app that renders the
OpenScience MDX pages as a hash-routed single-page site.

- Guides and CLI reference for OpenScience only: index, quickstart,
  workspace, agents, models, skills, sessions, atlas, commands, security.
- Served under openscience.sh/docs (Vite base /docs/, SPA rewrite in
  vercel.json); assets and fonts resolve beneath /docs/.
- OpenScience wordmark, favicon, and a Star on GitHub call to action.
- typecheck (tsc --noEmit) and the CI docs build both pass.

* docs: use the working openscience.sh/install URL in quickstart
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs quickstart documents a Docker image that doesn't exist

1 participant